<html lang="en" xml:lang="en"><head>
<META http-equiv="Content-Type" content="text/html">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><META name="description" content="Install and start Web AppBuilder"><meta name="content-language" content="en"><link href="rsrc/htmlhelp.css" rel="stylesheet" type="text/css"><title>Web AppBuilder for ArcGIS | Help - Get
started
</title>
                <script type="text/javascript" language="JavaScript">
                    var pathL  = self.location.pathname.split ("/");
                    var fname = pathL[pathL.length-1];
                    var i = fname.lastIndexOf (".htm");
                    if (i>=0) {
                    fname = fname.substring (0, i)
                    } else {
                    //??
                    }
                    if (self.location.hash) {
				    		      fname = fname + self.location.hash;
						        }
                    self.location.replace ("../index.html#//" + fname);
                </script>
                </head><!--Publication GUID: [GUID-E7D1C130-8F87-4109-8D61-E73A46083F52]--><!--Topic GUID: [GUID-5E78E1A8-6F25-46B1-A1AD-75C8FBC1D215]--><body><div id="content"><div class="header"><h1>Get
started
</h1><div id="breadcrumb"></div></div>
    <div class="section1" id="GUID-37BA9034-D38D-4938-B2F4-6325D45459F5" purpose="section1"><h2>
Install</h2></div>
    <div class="wfsteps" purpose="wfsteps"><h4></h4><div class="steps" id="GUID-01F5385C-B1B8-40C7-859D-8BDBA9D25E43"><div class="step_title">Steps:</div><ol>
        <li purpose="step" id="GUID-04EE6958-DEC5-4490-97DB-A532BE2F2A5D">
          <span purpose="cmd" id="GUID-12478BD7-AAF9-43DC-A9C7-D3A0DFF79470">
            <a target="_blank" class="xref" href="https://developers.arcgis.com/web-appbuilder/" rel="https://developers.arcgis.com/web-appbuilder/">Download</a> the <span purpose="ph" varid="wab">Web AppBuilder for ArcGIS</span> (Developer Edition) ZIP file to your local drive and unzip it.
</span>
        </li>
        <li purpose="step" id="ESRI_STEP_EF4349FCBAAD4132B9A88D89FE034BDC">
          <span purpose="cmd" id="GUID-04AA95F2-D467-4769-B419-0E3E4F9B757E">Because Web AppBuilder runs on top of <a target="_blank" class="xref" href="http://nodejs.org/" rel="http://nodejs.org/">Node.js</a>, you must have  Node.js installed on your computer. The download package contains the Windows version of Node.js.  </span>
          <ul purpose="choices" id="ESRI_CHOICES_42A1996278DE4ED19A2A765B2A93582A">
            <li purpose="choice" id="ESRI_CHOICE_8B5F814957804A20BB64D3C66E7830B3"> If you are on a Windows platform, you can follow the steps in the next section to start Web AppBuilder. </li>
            <li purpose="choice" id="ESRI_CHOICE_2C85A9B35B73436492B8173997B98E7F"> If you are on a platform other than Windows, such as Mac or Linux,  you need to install <a target="_blank" class="xref" href="http://nodejs.org/download/" rel="http://nodejs.org/download/">Node.js</a> independently on your platform first.  If you already have Node.js installed, make sure its version is 0.10.0 or later. </li>
          </ul>
        </li>
        <div class="stepinfo" purpose="stepinfo">
          <div class="notes" id="GUID-7567996C-769B-4027-BE6E-AC5223EF3343"><div class="note"><img class="note_img" src="rsrc/note.png" alt="Note" title="Note"><span>Note:</span></div><div class="tipbody">
            <p id="GUID-7449FE6A-7397-450E-8212-0908EDA9FEE3">The minimum version of Node.js supported by Web AppBuilder is 0.10.0. </p>
          </div></div>
          
        </div>
      </ol></div></div>
    <div class="section1" id="ESRI_SECTION1_CC56C6A20C1A4492B24E9E7BD743A337" purpose="section1"><h2>Start Web AppBuilder</h2></div>
    <div class="wfsteps" purpose="wfsteps"><h4></h4><div class="steps" id="ESRI_STEPS_F9FE5D01354C4FAA95071F6FEE271253"><div class="step_title">Steps:</div><ol>
        <li purpose="step" id="ESRI_STEP_A3A02CB2FB3C4891A387997613A1F20A">
          <span purpose="cmd" id="GUID-F01DC507-64F8-41F4-938E-F8DCFF4A8245">Start Web AppBuilder based on your platform.</span>
          <ul purpose="choices" id="ESRI_CHOICES_CD5FF49B72064746B55494E7801985DF">
            <li purpose="choice" id="ESRI_CHOICE_14A02BC24ADA4083AF5A774DD53DA3D1">On Windows, double-click the startup.bat file in the unzipped folder. The batch file starts the Node.js server in the Command Prompt window and  Web AppBuilder  in your default browser with  <span class="usertext">http://[yourmachinename]:3344/webappbuilder</span>. If the browser is closed, you can reopen Web AppBuilder  in the same—or a different—browser as long as Node.js is running in the Command Prompt window. <div class="notes" id="GUID-6939AD02-687D-474F-896C-EA735923DC0F"><div class="tip"><img class="note_img" src="rsrc/tip.png" alt="Tip" title="Tip"><span>Tip:</span></div><div class="tipbody"><p id="GUID-06B2EDCD-2F88-439D-875A-5B6E870E9C07"> If the machine is in domain, it is sometimes required to include domain name along with the machine name   to get started, like  <span class="usertext">http://[yourmachinename].[yourdomain]:3344/webappbuilder</span>.</p></div></div></li>
            <li purpose="choice" id="ESRI_CHOICE_E35F19C8B75F4C0E85BF2277A88FFEAD">On other platforms,  open the  Command Prompt window, cd  to the <span class="usertext">/server</span> directory of  the Web AppBuilder installation, and type <span class="usertext">node server.js</span>. Once Node.js runs, start Web AppBuilder in the browser with <span class="usertext">http://[yourmachinename]:3344/webappbuilder</span>. If the browser is closed, you can reopen Web AppBuilder  in the same—or a different—browser as long as Node.js is running in the Command Prompt window. </li>
          </ul>
        </li>
        <li purpose="step" id="ESRI_STEP_8C085C0DA2BC4C1FB170289274E56AC7">
          <span purpose="cmd" id="GUID-CE4CCDA7-3946-4B9D-ACC5-757E2B85D67C">Web AppBuilder runs on top of <a target="_blank" class="xref" href="http://nodejs.org/" rel="http://nodejs.org/">Node.js</a> with the default port of 3344. To run Web AppBuilder with additional parameters,   different ports, or as a Windows service,  complete the following steps. Otherwise, see the Specify your portal URL section. </span>
          <ul purpose="choices" id="ESRI_CHOICES_413C98FF708448DBAD22AC60EB1D8A24">
            <li purpose="choice" id="ESRI_CHOICE_BA4FA58135AA44ED9EB0E53CE05B2D18">Run with additional parameters and different ports.<ol purpose="ol" id="OL_F3F5203290C34F7C9AD97708130BFEAC"><li purpose="li" id="LI_F633CCAD65C941CC8026A7B41B29C56D">Open a command window and browse to the <span class="usertext">/server</span> directory of   the Web
AppBuilder installation. <ul purpose="ul" id="UL_9DA53D652CED4F18AF82A89084354D9E"><li purpose="li" id="LI_206E499F3B094EF5B8D61175117EDAD6">On 64-bit Windows, type <span class="usertext">node_x64.exe server.js [-port=value]
[-proxy=value]</span>.</li><li purpose="li" id="LI_3E13D7B7CBB84B47A1EAF24EF2951E1F">On 32-bit Windows, type <span class="usertext">node_x32.exe server.js [-port=value]
[-proxy=value]</span>.</li><li purpose="li" id="LI_A04DAA32F863437D809D1899B55F1047">On other platforms, type  <span class="usertext">node server.js [-port=value]
[-proxy=value]</span>.</li></ul><div class="notes" id="GUID-41D13922-3FCC-4D2F-BF12-E5E2C9DA85C3"><div class="note"><img class="note_img" src="rsrc/note.png" alt="Note" title="Note"><span>Note:</span></div><div class="tipbody"><p id="GUID-BAB690AE-5EE2-4772-AFC4-E8F37F66C236"><span class="usertext">-port</span> specifies the port  you want Node.js to run on, and <span class="usertext">-proxy</span> specifies the proxy URL if needed. Make sure your proxy URL starts with http or https.</p></div></div></li><li purpose="li" id="LI_E1BC2D124B3847A98A72F369ABF39B64"> Start Web AppBuilder in the browser with the port number specified above at  <span class="usertext">http://[yourmachinename]:[yourport]/webappbuilder</span>.<div class="notes" id="GUID-A7D8DD4B-F313-4D47-83B7-27EF4FB47EE5"><div class="tip"><img class="note_img" src="rsrc/tip.png" alt="Tip" title="Tip"><span>Tip:</span></div><div class="tipbody"><p id="GUID-E0FFB1B3-EB2F-4096-A9B2-15A741EC5405">If you have problems starting Web AppBuilder, see <a class="xref" rel="03w3/03w30000004r000000.htm" href="03w3/03w30000004r000000.htm">FAQs</a> for more information.</p></div></div></li></ol></li>
            <li purpose="choice" id="ESRI_CHOICE_1D39E37870164BEC9723892065104371"><a class="xref" rel="03w3/03w30000007n000000.htm" href="03w3/03w30000007n000000.htm">Run as a Windows service</a>.</li>
          </ul>
        </li>
      </ol></div></div>
    <div class="section1" id="ESRI_SECTION1_684109CB65F347019BB3EEC3F9E2A940" purpose="section1"><h2>Specify  your portal URL</h2></div>
    <div class="wfsteps" purpose="wfsteps"><h4></h4><div class="steps" id="ESRI_STEPS_B59AA577722442A69E646E3D121690E4"><div class="step_title">Steps:</div><ol>
        <li purpose="step" id="ESRI_STEP_3BCBBCDB407C468AABDE68E67C73579E">
          <span purpose="cmd" id="GUID-5AAC96C3-465E-4C85-BDD6-3C517B7EDD1C">Specify the URL for the ArcGIS Online organization or Portal for ArcGIS account that you want Web AppBuilder to access. To use Web AppBuilder, you must have an ArcGIS Online organization account, a Portal for ArcGIS account, or an ArcGIS for Developers account.</span>
          <div class="info" purpose="info">
            <div class="notes" id="GUID-781B4AB5-DB23-4357-8810-25F6EE221F58"><div class="subscription"><img class="note_img" src="rsrc/subscription.png" alt="Subscription" title="Subscription"><span>Subscription:</span></div><div class="tipbody">
              <p id="GUID-FC4FAE41-3090-444A-8B64-4AEE4F8054DF">  Sign up for the <a target="_blank" class="xref" href="http://www.esri.com/software/arcgis/arcgisonline/evaluate" rel="http://www.esri.com/software/arcgis/arcgisonline/evaluate">ArcGIS Online Trial account</a> or the  <a target="_blank" class="xref" href="https://developers.arcgis.com/en/sign-up/" rel="https://developers.arcgis.com/en/sign-up/">ArcGIS for Developers introductory account</a>.</p>
            </div></div>
          </div>
        </li>
        <li purpose="step" id="ESRI_STEP_A02598554FDC421CA40B595BF0E46295">
          <span purpose="cmd" id="GUID-C4180A49-45FA-46A3-BA96-68AEA49FB7B2">Click <span class="uicontrol">Continue</span>.</span>
        <ul purpose="choices" id="ESRI_CHOICES_57A4038A33BC4D47A950372B09E74502"><li purpose="choice" id="ESRI_CHOICE_BAEA8A03401A428EBC86E6E34783223F">If the portal you specified above uses web-tier authentication, skip the next section. After log in, you can <a class="xref" rel="03w3/03w300000054000000.htm" href="03w3/03w300000054000000.htm">build your first app</a>.</li><li purpose="choice" id="ESRI_CHOICE_27E5E642E0644700BE32A3C5BCAFDB57">If you're using ArcGIS Online organization or portal with OAuth2 authentication, follow the steps in the next section to provide an App ID for Web AppBuilder. </li></ul></li>
      </ol></div></div>
    <div class="section1" id="ESRI_SECTION1_F2CE6567CB854E4AB43F08EB64B3D7AE" purpose="section1"><h2>Provide an app ID for Web AppBuilder</h2><p id="GUID-B412398A-4D55-4849-9B6A-07F856D2E9A7">Since this is  the first time you've used Web AppBuilder with the portal specified above, you may be asked to provide  an app ID for Web AppBuilder to support OAuth2 authentication. For a specified portal, this process is required once. When you subsequently start Web AppBuilder, you can log in to the  portal directly.</p><p id="GUID-04CD3FCB-ED38-46D8-A2B9-36142F7A99D3"> Do the following to retrieve an app ID:</p></div>
    <div class="wfsteps" purpose="wfsteps"><h4></h4><div class="steps" id="ESRI_STEPS_787EEC2F7C5D45F686133F44A2C576DB"><div class="step_title">Steps:</div><ol>
        <li purpose="step" id="ESRI_STEP_710965BD29064294BE5A50D970482948">
          <span purpose="cmd" id="GUID-7A5EFB0F-6156-48F2-97D7-E9889239DF5B">Log in to the  portal you specified above.</span>
        </li>
        <li purpose="step" id="ESRI_STEP_E726FC6104CF43D992C3457998DD0D8F">
          <span purpose="cmd" id="GUID-B513075B-DF93-4E63-86EA-6583E7AC3EF9">Add Web AppBuilder as an   item. </span>
          <ul purpose="choices" id="ESRI_CHOICES_FA398CDBCD024E43AE731FBE60500AF6">
            <li purpose="choice" id="ESRI_CHOICE_B2FB070CD91E4C579DEB62998BD96668">For an ArcGIS Online organization or a Portal for ArcGIS 10.3.1 and later account, do the following:<ol purpose="ol" id="OL_FC23717C81E94859BA3DD5272320DD98"><li purpose="li" id="LI_A5A722F9B3604778834B87E019F4C058">Go to <span class="uicontrol">My Content</span>. click  <span class="uicontrol">Add Item</span>, and choose <span class="uicontrol">An Application</span>.</li><li purpose="li" id="LI_040B99A4307542ADA094F4E1BEF4AD9D">In the Application dialog box, change the following items. Keep the default values for the rest of the items.<ul purpose="ul" id="UL_0B489B4D71AE4CA5BCABAACF9F76E6E3"><li purpose="li" id="LI_16195E363983458BAC402BEE3A20232D">URL—Enter <span class="usertext">http://[yourmachinename]:3344/webappbuilder</span>.<div class="notes" id="GUID-D3ED1CB5-3195-4FFA-A874-8B717DE7C87F"><div class="tip"><img class="note_img" src="rsrc/tip.png" alt="Tip" title="Tip"><span>Tip:</span></div><div class="tipbody"><p id="GUID-3541DF05-0FB8-45F4-94D3-4D848FC0F9CB">If the Web AppBuilder is started with the machine name along with the domain name, enter <span class="usertext">http://[yourmachinename].[yourdomain]:3344/webappbuilder</span>.</p></div></div></li><li purpose="li" id="LI_EA80B212A37F418197A482FB4403618B">Title—Enter something that makes sense to you, such as <span class="usertext">Web AppBuilder for ArcGIS</span>.</li><li purpose="li" id="LI_94481062B9C94B42A8C9EF1DF516B0C7">Tags—Enter something that is easy to search, such as <span class="usertext">Registered Web AppBuilder</span>.</li></ul><div class="image" purpose="image"><table><tr><td><img class="break" src="03w3/GUID-E631FF0A-F94D-4AF8-847F-C77C496B5615-web.png" purpose="img" alt="Add Item dialog box for ArcGIS Online and Portal for ArcGIS 10.3.1 and later" title="Add Item dialog box for ArcGIS Online and Portal for ArcGIS 10.3.1 and later"></td></tr></table></div></li><li purpose="li" id="LI_4E431E58EED74F10925E8565D9135199">Click <span class="uicontrol">Add Item</span>.</li></ol></li>
            <li purpose="choice" id="ESRI_CHOICE_91147292D27A4DC792806C08343B5507">For Portal for ArcGIS 10.3, do the following: <ol purpose="ol" id="OL_0C11C43DFF6843C18E6106620EB0C72A"><li purpose="li" id="LI_435E1B427A8940B89B55D402FA267FC3">Go to <span class="uicontrol">My Content</span> and click <span class="uicontrol">+ Add Item</span>.</li><li purpose="li" id="LI_DAE4751E72A44C7B90C22E4E43D37B34">In the Add Item dialog box, in The item is text box, choose An application as shown below. Change the following items.  Keep default values for the rest of the items.<ul purpose="ul" id="UL_4D0E7708F68042B6809F5C5F36D9CACC"><li purpose="li" id="LI_D374424D49C84B5F950BADD5E82E113B">URL—Enter <span class="usertext">http://[yourmachinename]:3344/webappbuilder</span>.<div class="notes" id="GUID-379E8B3B-8844-4EC5-AE92-92B821320CDD"><div class="tip"><img class="note_img" src="rsrc/tip.png" alt="Tip" title="Tip"><span>Tip:</span></div><div class="tipbody"><p id="GUID-2B18EB92-5E8D-4445-951F-5E7A5FCFDAE1">If the Web AppBuilder is started with the machine name along with the domain name, enter <span class="usertext">http://[yourmachinename].[yourdomain]:3344/webappbuilder</span>.</p></div></div></li><li purpose="li" id="LI_1291437AD97F46079F0AA925754FCC80">Title—Enter something that makes sense to you, such us <span class="usertext">Web AppBuilder for ArcGIS</span>.</li><li purpose="li" id="LI_F679667670484C1D83DF8DE0FE05E6FA">Tags—Enter something that is easy to search, such as <span class="usertext">Registered Web AppBuilder</span>.</li></ul><div class="image" purpose="image"><table><tr><td><img class="break" src="03w3/GUID-051D4B55-11A0-4720-8291-C3DDE5FACC58-web.png" purpose="img" alt="Add Item dialog box for Portal for ArcGIS 10.3" title="Add Item dialog box for Portal for ArcGIS 10.3"></td></tr></table></div></li><li purpose="li" id="LI_59F6BC44194A48BDA00F2B43A3381D2F">Click <span class="uicontrol">Add Item</span>.</li></ol></li>
          </ul>
        </li>
        <li purpose="step" id="ESRI_STEP_0F0873D9455D471E83316F855CCA509A">
          <span purpose="cmd" id="GUID-97EAEB0A-C831-4010-9FAC-E8D36AED6A34">On the item details page, do the following:</span>
        <ul purpose="choices" id="ESRI_CHOICES_EC1BE06F130E45839B067CD3AC3A88B7"><li purpose="choice" id="ESRI_CHOICE_7080642485894CBD83EA716E86627091">For an ArcGIS Online organization or an ArcGIS for Developers account, click the <span class="uicontrol">Settings</span> tab. Scroll down to the <span class="uicontrol">App Registration</span> section and click <span class="uicontrol">Register</span>. </li><li purpose="choice" id="ESRI_CHOICE_6D1AC96AF29F4D18BA7DB4CCBF7262AF">For Portal for ArcGIS, click <span class="uicontrol">Register</span> in the <span class="uicontrol">App Registration</span> section. </li></ul></li>
        <li purpose="step" id="ESRI_STEP_2FCEF9A55A3444FA8EEE0ACC4A8B6569">
          <span purpose="cmd" id="GUID-0BCD780A-BAE5-4F98-ADB3-F27BC37358B6">On the Register dialog box as shown below, for App Type, keep the default value.  For  Redirect URI, enter  <span class="usertext">http://[yourmachinename]</span> or   <span class="usertext">https://[yourmachinename]</span> and click <span class="uicontrol">Add</span>. Be aware that URIs with HTTP and HTTPS protocols are distinguished as two different URIs. It is strongly recommended adding both of them to the URI list to  avoid potential redirect issues.<div class="image" purpose="image"><table><tr><td><img class="break" src="03w3/GUID-F64E7321-1EBB-44F2-9E2C-7E8DCC50FD00-web.png" purpose="img" alt="Register dialog box" title="Register dialog box"></td></tr></table></div></span>
        <div class="info" purpose="info"><div class="notes" id="GUID-D6C42104-707B-45C0-ACA1-6EDC5050267E"><div class="tip"><img class="note_img" src="rsrc/tip.png" alt="Tip" title="Tip"><span>Tip:</span></div><div class="tipbody"><p id="GUID-F6CC4BA5-B50E-44E4-B79C-D27181ADA679">If the Web AppBuilder is started with the machine name along with the domain name, enter <span class="usertext">http://[yourmachinename].[yourdomain] </span>or <span class="usertext"> https://[yourmachinename].[yourdomain]</span>.</p></div></div></div></li>
        <li purpose="step" id="ESRI_STEP_617AF8038E9F4DA1AEC18C2EF18B535B">
          <span purpose="cmd" id="GUID-DCB0F72B-4A0B-4715-A483-CC381491C0FD">Click <span class="uicontrol">Register</span>.</span>
        </li>
        <li purpose="step" id="ESRI_STEP_B9B470D1F93D4AADA539CC65A4F2F8D6">
          <span purpose="cmd" id="GUID-24F5326C-5AFA-4FF9-8608-30B1CFE0C395">On the item details page, copy the app ID under App Registration. </span>
        </li>
        <li purpose="step" id="ESRI_STEP_EB5DEFAFF7194FC4A2555224A32D1605">
          <span purpose="cmd" id="GUID-906E2CB1-AC3F-4FD4-8F17-BA8222F73DFD">In the browser, paste the app ID  into the text box of Web AppBuilder, and click <span class="uicontrol">Continue</span>.</span>
          <div class="stepresult" purpose="stepresult">
            <p id="GUID-F3510329-BE33-4936-A2D7-E38B135D3408">If you get an Error 400 with Invalid redirect_url, complete the following steps:<ol purpose="ol" id="OL_6E042DFFCFAE488D9CAA49C1EB67B30C"><li purpose="li" id="LI_FA5A60C59EF0431BB70BCC05AF6DDE97">Go to  the <span class="usertext">/server</span> directory of  the Web AppBuilder installation, and delete the signininfo.json file.</li><li purpose="li" id="LI_B3C37271556A450E9DFF8D09C05A0EBD">Review  step 4. Update the existing app ID with the correct redirect URIs. You can also create a new app ID from scratch.</li><li purpose="li" id="LI_F8FAD64B2D6B46EB9141BE9B0C967F4F">Refresh the browser running Web AppBuilder.</li><li purpose="li" id="LI_12D40E8679604E58840BA60545D307AD">Provide your app ID again, and click <span class="uicontrol">Continue</span>. </li></ol></p>
          </div>
        </li>
        <li purpose="step" id="ESRI_STEP_7302A54C8EA241ADADCDAFCF9C21AA65">
          <span purpose="cmd" id="GUID-74D7CFA4-F0BA-45B9-B720-7A343BDC5DFF">Provide your credentials if you're not already logged in, or click <span class="uicontrol">Approve</span> on the Request for Permission dialog box.</span>
        </li>
        <div class="stepinfo" purpose="stepinfo">An app ID is required by OAuth 2 authentication. See <a target="_blank" class="xref" href="https://developers.arcgis.com/authentication/" rel="https://developers.arcgis.com/authentication/">Authentication and OAuth2</a>. If you have problems logging on, see <a class="xref" rel="03w3/03w30000004r000000.htm" href="03w3/03w30000004r000000.htm">FAQs</a> and <a target="_blank" class="xref" href="http://doc.arcgis.com/en/arcgis-online/share-maps/add-items.htm#esri_section1_55703f1ee9c845c3b07bbd85221fb074" rel="http://doc.arcgis.com/en/arcgis-online/share-maps/add-items.htm#esri_section1_55703f1ee9c845c3b07bbd85221fb074">Add apps and register your app</a>.</div>
      </ol></div></div>
    <div class="section1" id="ESRI_SECTION1_A36BF452E2D141F79EC1E40AC091E1E9" purpose="section1"><h2>Build your first app</h2><p id="GUID-0382ADF0-0E35-43DC-98D9-F8DA25452F54">You are now ready to <a class="xref" rel="03w3/03w300000054000000.htm" href="03w3/03w300000054000000.htm">build your first app</a>.</p></div>
    
  <div class="footer"> Copyright © 1995-2016 Esri. All rights reserved. </div></div></body></html>